home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / fap200.zip / FAP.DOC < prev    next >
Text File  |  1993-03-11  |  7KB  |  185 lines
  1. ─ FAP v2.00 ────────────────────────── Copyright Steve Mulligan 1992 - 1993 ─
  2.  
  3. NOTE : If you use FAP and you NetMail me, Steve Mulligan, at 1:163/307.30
  4.        then I will send you a NetMail every time I release a version of
  5.        FAP and I will tell you when and where I have sent it.
  6.  
  7. ─ Introduction ─
  8.  
  9.   File Announcer for Points (also called FAP) is a program that will scan
  10. any specified directory for new files and write them to a PKT file for your
  11. mailer to process.  It will convert RSP files to messages for you.  I made FAP
  12. because I like to F'REQ files a lot.  Sometimes too much.  Anyhow, I get all
  13. these files in and forget that I F'REQ'ed them and when I go look in my
  14. NetFile directory, I've got a ton of files.  After a while, I wished I had a
  15. program that would announce these files for me when they arrived.  
  16.  
  17. ─ Setting Up FAP ─
  18.  
  19.   To install FAP, just copy all the files to your mailer directory (if you
  20. have one).  Files in this archive should be:
  21.  
  22.      FAP.EXE                 - Executable program you run
  23.      FAP.OVR                 - FAP Overlay file
  24.      FAP.DOC                 - Your reading it
  25.      FAP.CFG                 - Sample config file
  26.      
  27.    After all the files are in the right spot, edit the text file FAP.CFG and
  28. change the options as necessary.  See the next section on how to set up the
  29. configuration file.
  30.  
  31. ─ FAP And The Config File ─
  32.  
  33.    Here is a list of all the config verbs that FAP understands.  All commands
  34. and parameters are not case sensitive.  They can have spaces anywhere.  If a
  35. line starts with a ; then it will be treated as a comment and skipped.
  36.  
  37. The NetFile option tells FAP where to look for new files.  You can
  38. enter up to 32 of these.  Duplicates will be ignored.
  39.  
  40. NetFile e:\modem\bbs\file
  41.  
  42. The PKTPath command points to the directory that PKT files are to be placed
  43. in.
  44.  
  45. PKTPath e:\modem\bbs
  46.  
  47. The Area option is the area tag of the echo area that FAP's messages should
  48. be tossed into.  This should be a valid area on your system so your mailer
  49. will be able to process the PKT files FAP creates.
  50.  
  51. Area CVPFILES
  52.  
  53. The FileExclude verb tells FAP where to find the list of files to
  54. exclude from new file scanning.  This file holds the full path and file name
  55. of any file that has been scanned by FAP.  If a file is found in a
  56. directory and is in the FileExclude file, it is not announced.  You can
  57. manually edit this file with a text editor.  The default is EXCLUDE.DAT
  58.  
  59. FileExclude FAP.DAT
  60.  
  61. The NumberAnnounce verb tells you how many files announcements will go in
  62. each message.  The default is 3.  If there are more than the number
  63. specified, it will be broken into multiple messages.  You cannot have more
  64. than 32 files per message.  Any number greater will be reset to 32.
  65.  
  66. NumberAnnounce 3
  67.  
  68. The AddressFrom verb is to define the address the message is from.  This
  69. MUST be included if there is no AddressTo verb.
  70.  
  71. AddressFrom 1:163/307.30
  72.  
  73. The AddressTo verb is to define the address the message is from.  This
  74. MUST be included if there is no AddressFrom verb.
  75.  
  76. AddressTo 1:163/307.30
  77.  
  78. The From verb is what appears on the From line of the message.  FAP and then
  79. the version is the default.  If you want the right version number displayed,
  80. do not include a from line.
  81.  
  82. From FAP v1.10
  83.  
  84. The To verb is what appears on the To line of the message.  All is the
  85. default.
  86.  
  87. To All
  88.  
  89. The Subject verb is what appears on the Subject line of the message.
  90. "New Files" is the default.  (without the surrounding quotes).  In all
  91. messages (after the subject) there will be a set of square brackets that
  92. hold the number of messages that have been announced.
  93.  
  94. Subject New Files
  95.  
  96. The OriginLine verb tells FAP what to put on the Origin Line of your
  97. message.  DO NOT PUT YOUR ADDRESS HERE.  It will be added to the end
  98. of the Origin Line by FAP.  The default is:
  99. 'Point System Using FAP ' + Version + ' * (' + FromAddress + ')'
  100.  
  101. OriginLine Carp Valley Point * Carp, Ontario
  102.  
  103. The TICAnnounce verb tells FAP if it should read into TIC files and
  104. announce the files that appear in them.  Valid options are Yes and No.  The
  105. default is Yes.
  106.  
  107. TICAnnounce Yes
  108.  
  109. The RSPAnnounce verb tells FAP if it should convert files with the RSP
  110. extension into a message.  Valid options are Yes and No.  The default is
  111. Yes.  Sometimes when you file request a file from a BBS but you get the
  112. password wrong or the file cannot be found, they BBS will return a RSP file.
  113. FAP will post this file to you message base.
  114.  
  115. RSPAnnounce Yes
  116.  
  117. The AlwaysExclude command will always exclude certain files from a scan.
  118. This is usefull to exclude mail packets or files you get on a regular basis.
  119. There are no defaults.  You can have 32 of these.
  120.  
  121. AlwaysExclude *.PKT
  122. AlwaysExclude *.SU*
  123. AlwaysExclude *.MO*
  124. AlwaysExclude *.TU*
  125. AlwaysExclude *.WE*
  126. AlwaysExclude *.TH*
  127. AlwaysExclude *.FR*
  128. AlwaysExclude *.SA*
  129.  
  130. ─ Running FAP ─
  131.  
  132.   Once you have done all the above, you can run FAP.  It takes one command
  133. line argument; the config file name.  You can rename FAP.CFG to any file and
  134. then type FAP <configname> or just keep the name and run fap without any
  135. command line options.
  136.  
  137.   FAP will display a title screen and proceed to scan your directories using
  138. some calls to DOS.  It will then put a list of all files that did not appear
  139. in the ExcludeFile file in a PKT file, awaiting your mailer to toss it.
  140.   
  141.   If a file did not appear in the ExcludeFile file, it will be added so that
  142. when FAP runs again, you will not get the same files announced over and over.
  143.  
  144.   FAP runs best in a batch file.  If you have a batch file to run your mailer
  145. and unpacker, make sure FAP is run BEFORE the mail is unpacked. Otherwise, you
  146. wont get the files announced until next time your mailer is run.
  147.  
  148.   If you continue to use FAP, I REALLY REALLY want to hear from you.  I just
  149. want to know if you like the program or you think I should stop development.
  150. If you wish to make a comment (PLEASE) NetMail Steve Mulligan 1:163/307.30
  151.  
  152. ─ Beta Testers Wanted ─
  153.  
  154.   If you are in the 163 or 243 net or you don't mind polling long distance
  155. you are eligible to be a beta testers.  Simply NetMail Steve Mulligan at
  156. 1:163/307.30.  I will reply to you and tell you how to get the latest beta
  157. versions of software I make.
  158.  
  159. ─ On the Drawing Board ─
  160.  
  161.    This is a list of all the features my Beta Testers and I want to have added
  162. to FAP.  I'll get around to it in a while.  PLEASE ADD TO LIST AND FORWARD TO
  163. STEVE MULLIGAN 1:163/307.30.  If you want to become a Beta Tester, NetMail me
  164. and I'll send you beta releases.
  165.  
  166. 2.50    · Change all config errors to errorlevel to 3
  167.       All runtime errors to errorlevel 2
  168.       Finding and announcing files to errorlevel 1
  169.       No files announced to errorlevel 0
  170.     · Option to write file announcement to Text File.
  171.     · Add byte count in file announcement.
  172.     · Header & Footer in file announcement.
  173.     · Update FileExclude at the end of program execution.
  174.     · Due out Jun 93
  175.  
  176. 3.00    · Allow user to change appearance of file announcements.
  177.     · Due out Sep 93
  178.  
  179. 4.00    · Get rid of excess units and global variables.
  180.     · Due out Dec 93
  181.  
  182. If you have any additions to this list or any bugs, please let me know!
  183.  
  184. Steve Mulligan 1:163/307.30@fidonet.org
  185.